/*-------------------------------------------------------------------------
 *
 * pg_crc32c_armv8_choose.c
 *	  在ARMv8和软件CRC-32C实现之间进行选择。
 *
 * 首次调用时，检查我们正在运行的CPU是否支持ARMv8的CRC扩展。
 * 如果支持，则使用专用的CRC-32C计算指令。否则，回退到纯软件实现
 * （按8切片）。
 *
 * Portions Copyright (c) 1996-2022, PostgreSQL Global Development Group
 * Portions Copyright (c) 1994, Regents of the University of California
 *
 *
 * IDENTIFICATION
 *	  src/port/pg_crc32c_armv8_choose.c
 *
 *-------------------------------------------------------------------------
 */

#ifndef FRONTEND
#include "postgres.h"
#else
#include "postgres_fe.h"
#endif

#include <setjmp.h>
#include <signal.h>

#include "port/pg_crc32c.h"


static sigjmp_buf illegal_instruction_jump;

/*
 * 通过尝试执行 pg_comp_crc32c_armv8() 来探测。如果指令
 * 不可用，我们预计会收到 SIGILL，这可以被捕获。
 */
static void illegal_instruction_handler(SIGNAL_ARGS)
{
	siglongjmp(illegal_instruction_jump, 1);
}

static bool pg_crc32c_armv8_available(void)
{
	uint64		data = 42;
	int			result;

	/*
	 * 在设置了非标准值的 SIGILL 处理程序时，要小心不要做任何可能引发错误的事情。
	 */
	pqsignal(SIGILL, illegal_instruction_handler);
	if (sigsetjmp(illegal_instruction_jump, 1) == 0)
	{
		/* 与其硬编码一个预期结果，不如与 SB8 代码进行比较 */
		result = (pg_comp_crc32c_armv8(0, &data, sizeof(data)) ==
				  pg_comp_crc32c_sb8(0, &data, sizeof(data)));
	}
	else
	{
		/* 我们收到了 SIGILL 捕获 */
		result = -1;
	}
	pqsignal(SIGILL, SIG_DFL);

#ifndef FRONTEND
	/* 我们不期望这个情况，所以大声抱怨 */
	if (result == 0)
		elog(ERROR, "crc32 hardware and software results disagree");

	elog(DEBUG1, "using armv8 crc32 hardware = %d", (result > 0));
#endif

	return (result > 0);
}

/*
 * 这是在第一次调用时调用的。它替换了函数指针
 * 以便后续调用直接路由到选定的实现。
 */
static pg_crc32c
pg_comp_crc32c_choose(pg_crc32c crc, const void *data, size_t len)
{
	if (pg_crc32c_armv8_available())
		pg_comp_crc32c = pg_comp_crc32c_armv8;
	else
		pg_comp_crc32c = pg_comp_crc32c_sb8;

	return pg_comp_crc32c(crc, data, len);
}

pg_crc32c	(*pg_comp_crc32c) (pg_crc32c crc, const void *data, size_t len) = pg_comp_crc32c_choose;
